Index
© 2006 - 2013 Ekahau, Inc.
| asset-service supports 15 commands: | Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index |
| /epe/asset/assetaddtogroups POST version | Input: | Output: | |
|
Description:
Add group memberships to an asset. Differs from assetsetgroups by keeping existing memberships, i.e. does not remove asset from any groups. Example 1: Add asset 321 to groups 510 & 511
Role Required:
tagoperator
|
assetid (required) - [long] asset id
assetgroupid (required) - [Array] array of asset group ids to add asset to |
||
| /epe/asset/assetcreate POST version | Input: | Output: | |
|
Description:
Creates a new asset
Role Required:
tagoperator
|
name (required) - [String] asset name
|
ASSET.assetid - [long] asset identifier
ASSET.name - [String] asset name ASSET.createdon - [String] create time of the asset ASSET.modifiedon - [String] modify time of the asset |
|
| /epe/asset/assetdelete POST version | Input: | Output: | |
|
Description:
Deletes an asset
Role Required:
tagoperator
|
assetid (required) - [Array] id of the asset to be deleted
|
||
| /epe/asset/assetedit POST version | Input: | Output: | |
|
Description:
Edit asset properties
Role Required:
tagoperator
|
assetid (required) - [long] asset identifier
name (required) - [String] asset name |
ASSET.assetid - [long] asset identifier
ASSET.name - [String] asset name ASSET.createdon - [String] create time of the asset ASSET.modifiedon - [String] modify time of the asset |
|
| /epe/asset/assetgroupcreate POST version | Input: | Output: | |
|
Description:
Create a new asset group. Example 1: Create a new group with name 'MyAssetGroup'
Role Required:
tagoperator
|
name (required) - [String] name of the asset group
description (optional) - [String] description |
ASSETGROUP.assetgroupid - [long] asset group id
ASSETGROUP.name - [String] name of the asset group ASSETGROUP.description - [String] description ASSETGROUP.createdon - [String] asset group create time ASSETGROUP.modifiedon - [String] asset group modification time |
|
| /epe/asset/assetgroupdelete POST version | Input: | Output: | |
|
Description:
Delete an asset group. The assets are not deleted; only membership is removed. Example 1: Delete asset group 1
Role Required:
tagoperator
|
assetgroupid (required) - [long] asset group id
|
||
| /epe/asset/assetgroupedit POST version | Input: | Output: | |
|
Description:
Edit asset group properties. Example 1: Edit name of asset group 1
Role Required:
tagoperator
|
assetgroupid (required) - [long] asset group id
name (optional) - [String] name of the asset group description (optional) - [String] description |
||
| /epe/asset/assetgrouplist POST version | Input: | Output: | |
|
Description:
Lists asset groups. Ordered by name. Example 1: List asset group 1
Role Required:
viewer
|
assetgroupid (optional) - [long] asset group id
|
ASSETGROUP.assetgroupid - [long] asset group id
ASSETGROUP.name - [String] name of the asset group ASSETGROUP.description - [String] description ASSETGROUP.createdon - [String] asset group create time ASSETGROUP.modifiedon - [String] asset group modification time |
|
| /epe/asset/assetlist POST version | Input: | Output: | |
|
Description:
Lists assets
Role Required:
tagoperator
|
assetid (optional) - [long] asset identifier
|
ASSET.assetid - [long] asset identifier
ASSET.name - [String] asset name ASSET.assetgroupid - [Array] ids of groups where the asset belongs to |
|
| /epe/asset/assetremovefromgroups POST version | Input: | Output: | |
|
Description:
Remove group memberships from an asset. Example 1: Remove asset 321 from groups 510 & 511
Role Required:
tagoperator
|
assetid (required) - [long] asset id
assetgroupid (required) - [Array] array of asset group ids to add asset to |
||
| /epe/asset/assetsetgroups POST version | Input: | Output: | |
|
Description:
Set group memberships of an asset. Asset may belong to any number of groups. You can list asset group membership with assetlist call. Example 1: Set asset 321 to groups 510 & 515 Example 2: Remove asset 345 from all groups
Role Required:
tagoperator
|
assetid (required) - [long] asset id
assetgroupid (required) - [Array] array of asset group ids; if not specified, removes asset from all groups |
||
| /epe/asset/tagbind POST version | Input: | Output: | |
|
Description:
Bind tags to assets
Role Required:
tagoperator
|
assetid (required) - [long] asset identifier
tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device |
||
| /epe/asset/_clear | Input: | Output: | |
|
Description:
SPECIAL. Resets all service specific counters.
Role Required:
poweruser
|
|||
| /epe/asset/_list POST version | Input: | Output: | |
|
Description:
SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions.
Role Required:
|
help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.
|
COMMAND.name - [String] command name
COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format |
|
| /epe/asset/_status | Input: | Output: | |
|
Description:
SPECIAL. Returns status information about the service.
Role Required:
viewer
|
STATUS.callcount - [int] total number of calls for the service
STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information |
||
(The data in this page was generated from /epe/asset/_list?help=1)